<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.job_model.PilotJob</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        <a href="simvoc.core.job_model-module.html">Module&nbsp;job_model</a> ::
        Class&nbsp;PilotJob
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class PilotJob</h1><p class="nomargin-top"><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_simvoc_c_17" name="uml_class_diagram_for_simvoc_c_17">
<area shape="rect" id="node33" href="simvoc.core.job_model.PilotJob-class.html#__init__" title="x.__init__(...) initializes x; see x.__class__.__doc__ for signature" alt="" coords="17,191,352,209"/>
<area shape="rect" id="node33" href="simvoc.core.job_model.PilotJob-class.html#start" title="Starts a pilot job." alt="" coords="17,209,352,228"/>
<area shape="rect" id="node33" href="simvoc.core.job_model.PilotJob-class.html#notify_done" title="Simulator&#45;aware method used by the external process (the one utilizing the &#160;pilot job to lease resources) to notify the pilot job to end" alt="" coords="17,228,352,247"/>
<area shape="rect" id="node33" href="simvoc.core.job_model.PilotJob-class.html#terminate" title="Notifies the external process (callback function) that the pilot job is &#160;being terminated (provided the job has started), then submits an event to &#160;terminate the pilot job immediately." alt="" coords="17,247,352,265"/>
<area shape="rect" id="node33" href="simvoc.core.job_model.PilotJob-class.html#kill" title="Kills the pilot job, notifying the external process (callback function) of &#160;the kill, if it is running." alt="" coords="17,265,352,284"/>
<area shape="rect" id="node1" href="simvoc.core.job_model.PilotJob-class.html" title="A pilot job is a job that is submitted to the grid for the purpose of leasing a remote resource." alt="" coords="5,158,363,290"/>
<area shape="rect" id="node3" href="simvoc.core.voc_sim.VMPilot-class.html" title="Pilot job for leasing physical machines to run virtual machines." alt="" coords="119,310,252,349"/>
<area shape="rect" id="node34" href="simvoc.core.job_model.Job-class.html#submit" title="Method called by the scheduler when submitting a job." alt="" coords="99,39,272,57"/>
<area shape="rect" id="node34" href="simvoc.core.job_model.Job-class.html#set_finish" title="Sets or updates the time at which the job will finish." alt="" coords="99,57,272,76"/>
<area shape="rect" id="node34" href="simvoc.core.job_model.Job-class.html#finish" title="Simulator&#45;aware method that is called at job completion time by an event &#160;set by the start() method." alt="" coords="99,76,272,95"/>
<area shape="rect" id="node34" href="simvoc.core.job_model.Job-class.html#__str__" title="str(x)" alt="" coords="99,95,272,113"/>
<area shape="rect" id="node34" href="simvoc.core.job_model.Job-class.html#__repr__" title="repr(x)" alt="" coords="99,113,272,132"/>
<area shape="rect" id="node2" href="simvoc.core.job_model.Job-class.html" title="Simulated representation of a regular job, which represents a workload submitted by the user to run on a remote system." alt="" coords="87,6,284,138"/>
</map>
  <img src="uml_class_diagram_for_simvoc_c_17.gif" alt='' usemap="#uml_class_diagram_for_simvoc_c_17" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>A pilot job is a job that is submitted to the grid for the purpose of 
  leasing a remote resource. Once obtained, the resource initiates a 
  callback to an overlay scheduler or other component, in order to retrieve
  the workload to be executed.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.PilotJob-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">callback</span>,
        <span class="summary-sig-arg">name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">vo</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="summary-sig-arg">pr_err</span>=<span class="summary-sig-default">0.0</span>,
        <span class="summary-sig-arg">**kwds</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="simvoc.core.results.JobStartResult-class.html" 
      class="link">results.JobStartResult</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.PilotJob-class.html#start" class="summary-sig-name">start</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">sim</span>,
        <span class="summary-sig-arg">node</span>)</span><br />
      Starts a pilot job.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.start">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.PilotJob-class.html#notify_done" class="summary-sig-name">notify_done</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">sim</span>)</span><br />
      Simulator-aware method used by the external process (the one 
      utilizing the pilot job to lease resources) to notify the pilot job 
      to end</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.notify_done">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.PilotJob-class.html#terminate" class="summary-sig-name">terminate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">signum</span>=<span class="summary-sig-default">15</span>)</span><br />
      Notifies the external process (callback function) that the pilot job 
      is being terminated (provided the job has started), then submits an 
      event to terminate the pilot job immediately.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.terminate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.PilotJob-class.html#kill" class="summary-sig-name">kill</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">simobj</span>)</span><br />
      Kills the pilot job, notifying the external process (callback 
      function) of the kill, if it is running.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.kill">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.Job-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      repr(x)
      <em>(Inherited from <a href="simvoc.core.job_model.Job-class.html">simvoc.core.job_model.Job</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#Job.__repr__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.Job-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      str(x)
      <em>(Inherited from <a href="simvoc.core.job_model.Job-class.html">simvoc.core.job_model.Job</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#Job.__str__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.Job-class.html#finish" class="summary-sig-name">finish</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">simobj</span>)</span><br />
      Simulator-aware method that is called at job completion time by an 
      event set by the start() method.
      <em>(Inherited from <a href="simvoc.core.job_model.Job-class.html">simvoc.core.job_model.Job</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#Job.finish">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.Job-class.html#set_finish" class="summary-sig-name">set_finish</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">when</span>,
        <span class="summary-sig-arg">simobj</span>)</span><br />
      Sets or updates the time at which the job will finish.
      <em>(Inherited from <a href="simvoc.core.job_model.Job-class.html">simvoc.core.job_model.Job</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#Job.set_finish">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type"><a href="simvoc.core.results.JobSubmitResult-class.html" 
      class="link">results.JobSubmitResult</a></span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simvoc.core.job_model.Job-class.html#submit" class="summary-sig-name">submit</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">time</span>,
        <span class="summary-sig-arg">sched</span>)</span><br />
      Method called by the scheduler when submitting a job.
      <em>(Inherited from <a href="simvoc.core.job_model.Job-class.html">simvoc.core.job_model.Job</a>)</em></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simvoc.core.job_model-pysrc.html#Job.submit">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__format__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__setattr__</code>,
      <code>__sizeof__</code>,
      <code>__subclasshook__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">callback</span>,
        <span class="sig-arg">name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">vo</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
        <span class="sig-arg">pr_err</span>=<span class="sig-default">0.0</span>,
        <span class="sig-arg">**kwds</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>x.__init__(...) initializes x; see x.__class__.__doc__ for 
  signature</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>callback</code></strong> - Callback function to invoke when the pilot job starts. This 
          function is invoked with 5 arguments: the start time, a reference
          to the simulator, a reference to the scheduler used to submit the
          pilot job, a reference to the machine on which the pilot job is 
          running, and a state flag (see the flags in the <a 
          href="simvoc.core.core_common-module.html" 
          class="link">core_common</a> module, prefixed with PJ_).</li>
        <li><strong class="pname"><code>name</code></strong> (str) - Name of the pilot job</li>
        <li><strong class="pname"><code>vo</code></strong> (str) - Name of the Virtual Organization associated with the pilot job</li>
        <li><strong class="pname"><code>pr_err</code></strong> (float) - Probability of pilot job error (range 0.0-1.0). If a random error
          occurs in the pilot, the callback function will NOT be invoked.</li>
        <li><strong class="pname"><code>kwds</code></strong> - Job extra data</li>
    </ul></dd>
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="start"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">start</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>,
        <span class="sig-arg">sim</span>,
        <span class="sig-arg">node</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.start">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Starts a pilot job. Since the length of the pilot job is not known a 
  priori, the job will execute until the notify_done() method is called or 
  the pilot job is killed. If the pilot job experiences a random error, it 
  will terminate at the same clock time, without invoking the callback.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> (float) - Clock time at which job is started</li>
        <li><strong class="pname"><code>sim</code></strong> - Reference to the simulator object</li>
        <li><strong class="pname"><code>node</code></strong> - Reference to the machine on which the job is to be started</li>
    </ul></dd>
    <dt>Returns: <a href="simvoc.core.results.JobStartResult-class.html" 
      class="link">results.JobStartResult</a></dt>
        <dd>result collection including any return value from the callback 
          function and a <a 
          href="simvoc.core.results.JobStartResult-class.html" 
          class="link">results.JobStartResult</a></dd>
    <dt>Overrides:
        <a href="simvoc.core.job_model.Job-class.html#start">Job.start</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="notify_done"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">notify_done</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>,
        <span class="sig-arg">sim</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.notify_done">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Simulator-aware method used by the external process (the one utilizing
  the pilot job to lease resources) to notify the pilot job to end</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> (number) - Current simulated time</li>
        <li><strong class="pname"><code>sim</code></strong> - Reference to the simulator object</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="terminate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">terminate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">signum</span>=<span class="sig-default">15</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.terminate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Notifies the external process (callback function) that the pilot job 
  is being terminated (provided the job has started), then submits an event
  to terminate the pilot job immediately.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>signum</code></strong> - Pilot job signal number (<a 
          href="simvoc.core.core_common-module.html#PJ_STOP" 
          class="link">core_common.PJ_STOP</a> or <a 
          href="simvoc.core.core_common-module.html#PJ_KILL" 
          class="link">core_common.PJ_KILL</a>)</li>
    </ul></dd>
    <dt>Returns:</dt>
        <dd>simulator results collection, which may be empty</dd>
  </dl>
</td></tr></table>
</div>
<a name="kill"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">kill</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">time</span>,
        <span class="sig-arg">simobj</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simvoc.core.job_model-pysrc.html#PilotJob.kill">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Kills the pilot job, notifying the external process (callback 
  function) of the kill, if it is running. A kill happens immediately, and 
  the external process MUST terminate immediately, for accurate simulation 
  (equivalent to a SIGKILL in UNIX). This method invokes the terminate() 
  method with a signal number of PJ_KILL.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>time</code></strong> (number) - Time at which pilot job is killed</li>
        <li><strong class="pname"><code>simobj</code></strong> - Reference to the simulator object</li>
    </ul></dd>
    <dt>Overrides:
        <a href="simvoc.core.job_model.Job-class.html#kill">Job.kill</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:31 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
